home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cato / Xm / XmGetPixmap.z / XmGetPixmap
Text File  |  1998-10-20  |  14KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp - A pixmap caching function that generates a
  10.           pixmap, stores it in a pixmap cache, and returns the pixmap
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////XXXXmmmm....hhhh>>>>
  14.  
  15.           PPPPiiiixxxxmmmmaaaapppp XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp ((((_s_c_r_e_e_n, _i_m_a_g_e__n_a_m_e, _f_o_r_e_g_r_o_u_n_d, _b_a_c_k_g_r_o_u_n_d))))
  16.                SSSSccccrrrreeeeeeeennnn    ****_s_c_r_e_e_n;;;;
  17.                cccchhhhaaaarrrr      ****_i_m_a_g_e__n_a_m_e;;;;
  18.                PPPPiiiixxxxeeeellll     _f_o_r_e_g_r_o_u_n_d;;;;
  19.                PPPPiiiixxxxeeeellll     _b_a_c_k_g_r_o_u_n_d;;;;
  20.  
  21.  
  22.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  23.           This page documents version 1.2 of the Motif library.
  24.  
  25.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.           XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp uses the parameter data to perform a lookup in
  27.           the pixmap cache to see if a pixmap has already been
  28.           generated that matches the data.  If one is found, a
  29.           reference count is incremented and the pixmap is returned.
  30.           Applications should use XXXXmmmmDDDDeeeessssttttrrrrooooyyyyPPPPiiiixxxxmmmmaaaapppp when the pixmap is
  31.           no longer needed.
  32.  
  33.           If a pixmap is not found, _i_m_a_g_e__n_a_m_e is used to perform a
  34.           lookup in the image cache.  If an image is found, it is used
  35.           to generate the pixmap, which is then cached and returned.
  36.  
  37.           If an image is not found, the _i_m_a_g_e__n_a_m_e is used as a
  38.           filename, and a search is made for an XXXX11110000 or XXXX11111111 bitmap
  39.           file.  If it is found, the file is read, converted into an
  40.           image, and cached in the image cache.  The image is then
  41.           used to generate a pixmap, which is cached and returned.
  42.  
  43.           If _i_m_a_g_e__n_a_m_e has a leading slash (////), it specifies a full
  44.           pathname, and XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp opens the file as specified.
  45.           Otherwise, _i_m_a_g_e__n_a_m_e specifies a filename.  In this case
  46.           XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp looks for the file along a search path specified
  47.           by the XXXXBBBBMMMMLLLLAAAANNNNGGGGPPPPAAAATTTTHHHH environment variable or by a default
  48.           search path, which varies depending on whether or not the
  49.           XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR environment variable is set.
  50.  
  51.           The XXXXBBBBMMMMLLLLAAAANNNNGGGGPPPPAAAATTTTHHHH environment variable specifies a search path
  52.           for X bitmap files.  It can contain the substitution field
  53.           %B, where the _i_m_a_g_e__n_a_m_e argument to XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp is
  54.           substituted for %B.  It can also contain the substitution
  55.           fields accepted by XXXXttttRRRReeeessssoooollllvvvveeeePPPPaaaatttthhhhnnnnaaaammmmeeee.  The substitution
  56.           field %T is always mapped to bbbbiiiittttmmmmaaaappppssss, and %S is always
  57.           mapped to NULL.
  58.  
  59.           If XXXXBBBBMMMMLLLLAAAANNNNGGGGPPPPAAAATTTTHHHH is not set but the environment variable
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR is set, the following pathnames are searched:
  75.  
  76.                     %%%%BBBB
  77.                     $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%LLLL////bbbbiiiittttmmmmaaaappppssss////%%%%NNNN////%%%%BBBB
  78.                     $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%llll////bbbbiiiittttmmmmaaaappppssss////%%%%NNNN////%%%%BBBB
  79.                     $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////bbbbiiiittttmmmmaaaappppssss////%%%%NNNN////%%%%BBBB
  80.                     $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%LLLL////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  81.                     $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%llll////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  82.                     $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  83.                     $$$$HHHHOOOOMMMMEEEE////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  84.                     $$$$HHHHOOOOMMMMEEEE////%%%%BBBB
  85.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////bbbbiiiittttmmmmaaaappppssss////%%%%NNNN////%%%%BBBB
  86.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////bbbbiiiittttmmmmaaaappppssss////%%%%NNNN////%%%%BBBB
  87.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////bbbbiiiittttmmmmaaaappppssss////%%%%NNNN////%%%%BBBB
  88.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  89.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  90.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  91.                     ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  92.  
  93.  
  94.           If neither XXXXBBBBMMMMLLLLAAAANNNNGGGGPPPPAAAATTTTHHHH nor XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR is set, the following
  95.           pathnames are searched:
  96.  
  97.                     %%%%BBBB
  98.                     $$$$HHHHOOOOMMMMEEEE////%%%%LLLL////bbbbiiiittttmmmmaaaappppssss////%%%%NNNN////%%%%BBBB
  99.                     $$$$HHHHOOOOMMMMEEEE////%%%%llll////bbbbiiiittttmmmmaaaappppssss////%%%%NNNN////%%%%BBBB
  100.                     $$$$HHHHOOOOMMMMEEEE////bbbbiiiittttmmmmaaaappppssss////%%%%NNNN////%%%%BBBB
  101.                     $$$$HHHHOOOOMMMMEEEE////%%%%LLLL////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  102.                     $$$$HHHHOOOOMMMMEEEE////%%%%llll////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  103.                     $$$$HHHHOOOOMMMMEEEE////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  104.                     $$$$HHHHOOOOMMMMEEEE////%%%%BBBB
  105.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////bbbbiiiittttmmmmaaaappppssss////%%%%NNNN////%%%%BBBB
  106.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////bbbbiiiittttmmmmaaaappppssss////%%%%NNNN////%%%%BBBB
  107.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////bbbbiiiittttmmmmaaaappppssss////%%%%NNNN////%%%%BBBB
  108.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  109.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  110.                     ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  111.                     ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111////bbbbiiiittttmmmmaaaappppssss////%%%%BBBB
  112.  
  113.  
  114.           These paths are defaults that vendors may change.  For
  115.           example, a vendor may use different directories for
  116.           ////uuuussssrrrr////lllliiiibbbb////XXXX11111111 and ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111.
  117.  
  118.           The following substitutions are used in these paths:
  119.  
  120.  
  121.           %%%%BBBB   The image name, from the _i_m_a_g_e__n_a_m_e argument.
  122.  
  123.           %%%%NNNN   The class name of the application.
  124.  
  125.           %%%%LLLL   The display's language string.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp((((3333XXXX))))
  137.  
  138.  
  139.  
  140.           %%%%llll   The language component of the display's language
  141.                string.
  142.  
  143.  
  144.           Parameter descriptions are listed below:
  145.  
  146.  
  147.           _s_c_r_e_e_n    Specifies the display screen on which the pixmap
  148.                     is to be drawn.  The depth of the pixmap is the
  149.                     default depth for this screen.
  150.  
  151.           _i_m_a_g_e__n_a_m_e
  152.                     Specifies the name of the image to be used to
  153.                     generate the pixmap
  154.  
  155.           _f_o_r_e_g_r_o_u_n_d
  156.                     Combines the image with the _f_o_r_e_g_r_o_u_n_d color to
  157.                     create the pixmap if the image referenced is a
  158.                     bit-per-pixel image
  159.  
  160.           _b_a_c_k_g_r_o_u_n_d
  161.                     Combines the image with the _b_a_c_k_g_r_o_u_n_d color to
  162.                     create the pixmap if the image referenced is a
  163.                     bit-per-pixel image
  164.  
  165.  
  166.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  167.           Returns a pixmap when successful; returns
  168.           XXXXmmmmUUUUNNNNSSSSPPPPEEEECCCCIIIIFFFFIIIIEEEEDDDD____PPPPIIIIXXXXMMMMAAAAPPPP if the image corresponding to the
  169.           _i_m_a_g_e__n_a_m_e cannot be found.
  170.  
  171.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  172.           XXXXmmmmDDDDeeeessssttttrrrrooooyyyyPPPPiiiixxxxmmmmaaaapppp((((3333XXXX)))), XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaappppBBBByyyyDDDDeeeepppptttthhhh((((3333XXXX)))),
  173.           XXXXmmmmIIIInnnnssssttttaaaallllllllIIIImmmmaaaaggggeeee((((3333XXXX)))), and XXXXmmmmUUUUnnnniiiinnnnssssttttaaaallllllllIIIImmmmaaaaggggeeee((((3333XXXX)))).
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.